Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new minor version (1.1.0) of React Tip Magic, focusing on improved keyboard shortcut discoverability, documentation clarity, and sponsorship options. The most significant changes include a refactor of the keyboard shortcut API to use a dedicated
data-tip-shortcutattribute, comprehensive updates to documentation and usage examples, and the addition of fuzzy search support for shortcut discovery. There are also updates to Storybook story ordering and the introduction of a funding configuration file.Keyboard shortcut API and discoverability improvements:
data-tip-shortcutattribute instead of parsing tooltip text, making shortcut badges more explicit and easier to manage. All documentation and usage examples have been updated to reflect this change. [1] [2] [3] [4] [5] [6]fuzzysortdependency to enable fuzzy search for keyboard shortcuts in the TipAdvisor component, enhancing shortcut discoverability.Documentation and onboarding improvements:
README.mdto provide clearer onboarding, feature explanations, and usage patterns, with new sections for tooltips, guided tours, TipAdvisor, and programmatic API. [1] [2]1.1.0inpackage.jsonto reflect these breaking and additive changes.Storybook and project configuration:
The Tooltip,The Tourtip,The TipAdvisor) for improved documentation navigation..github/FUNDING.ymlto enable project sponsorship through multiple platforms.